Node Reference#
This page lists all the available node types which are shipped with the Execution Graph. Other Prism plugins can add additional node types. See the plugins documentation page for details.
Constants#
Bool#
Category: Constants
Description: Creates a boolean constant value.
- Settings:
Value (bool): The boolean value (default: true)
- Outputs:
Result (bool): The boolean value
Dict#
Category: Constants
Description: Creates a dictionary constant value.
- Settings:
Dict (multilinetext): The dictionary value as a string (default: "{}")
- Outputs:
Result (dict): The dictionary value
Float#
Category: Constants
Description: Creates a float constant value.
- Settings:
Value 1 (float): The float value (default: 1.0)
- Outputs:
Result (float): The float value
Integer#
Category: Constants
Description: Creates an integer constant value.
- Settings:
Value 1 (int): The integer value (default: 1)
- Outputs:
Result (int): The integer value
List#
Category: Constants
Description: Creates a list constant value.
- Settings:
List (multilinetext): The list value as a string (default: "[]")
- Outputs:
Result (list): The list value
String#
Category: Constants
Description: Creates a string constant value.
- Settings:
Value 1 (multilinetext): The string value (default: "")
- Outputs:
Result (text): The string value
DCCs#
Close Process#
Category: DCCs
Description: Closes a DCC process that was opened by a DCC node.
- Settings:
Process: The process object to close
- Outputs:
Result: The result of closing the process
Open Blender#
Category: DCCs
Description: Opens a Blender process in terminal mode for executing commands.
- Settings:
Blender Executable (text): Path to the Blender executable
- Outputs:
Process: The Blender process controller object
Open Hython#
Category: DCCs
Description: Opens a Hython (Houdini Python) process in terminal mode for executing commands.
- Settings:
Hython (text): Path to the Hython executable
- Outputs:
Process: The Hython process controller object
Open Mayapy#
Category: DCCs
Description: Opens a Mayapy (Maya Python) process in terminal mode for executing commands.
- Settings:
Mayapy (text): Path to the Mayapy executable
- Outputs:
Process: The Mayapy process controller object
Open Nuke Terminal#
Category: DCCs
Description: Opens a Nuke process in terminal mode for executing commands.
- Settings:
Nuke Executable (text): Path to the Nuke executable
- Outputs:
Process: The Nuke process controller object
Open Substance Painter#
Category: DCCs
Description: Opens a Substance Painter process with remote scripting enabled.
- Settings:
SP Executable (text): Path to the Substance Painter executable
- Outputs:
Process: The Substance Painter process controller object
Open USD Editor#
Category: DCCs
Description: Opens the USD Layer Manager editor.
- Settings:
USDFile (text): Path to the USD file
Stage: USD stage object (optional)
- Outputs:
Editor: The USD editor object
Write Cmd to Process#
Category: DCCs
Description: Sends a command to a DCC process and returns the output.
- Settings:
Process: The process object to send the command to
Command (multilinetext): The command to execute
- Outputs:
Process: The process object
Output: The output from the executed command
Data Processing#
Parse JSON#
Category: Data Processing
Description: Parses JSON data from text.
- Inputs:
Text: The JSON text to parse
- Outputs:
Result: The parsed JSON data
Parse XML#
Category: Data Processing
Description: Parses XML data from text.
- Inputs:
Text: The XML text to parse
- Outputs:
Result: The parsed XML data
Parse YAML#
Category: Data Processing
Description: Parses YAML data from text.
- Inputs:
Text: The YAML text to parse
- Outputs:
Result: The parsed YAML data
Deadline#
Get Job ID from Submit Result#
Category: Deadline
Description: Extracts the job ID from a Deadline submission result.
- Settings:
Result (multilinetext): The result string from Deadline submission
- Outputs:
JobID: The extracted job ID
Submit Graph to Deadline#
Category: Deadline
Description: Submits an Execution Graph to Deadline for rendering.
- Settings:
Path (text): Path to the graph file
Priority (int): Job priority (default: 50)
- Outputs:
(None)
Submit Houdini Job to Deadline#
Category: Deadline
Description: Submits a Houdini job to Deadline for rendering.
- Settings:
Job Name (text): Name of the job
Hipfile (text): Path to the Houdini file
Driver (text): Path to the output driver (default: "/out/mantra1")
Priority (int): Job priority (default: 50)
Dependencies (multilinetext): List of job dependencies (default: "[]")
- Outputs:
Result: The submission result
Discord#
Send Discord Message#
Category: Discord
Description: Sends a message to a Discord channel.
- Settings:
Token (text): Discord API token
Server (text): Discord server name
Channel (text): Discord channel name
Message (multilinetext): The message to send
Attachments (text): File paths to attach
- Outputs:
Output: The result of the operation
Email#
Send Email#
Category: Email
Description: Sends an email via SMTP.
- Settings:
Server (text): SMTP server address
Port (int): SMTP port (default: 587)
Password (text): SMTP password
From (text): Sender email address
To (text): Recipient email address
Subject (text): Email subject
Message (multilinetext): Email message body
- Outputs:
(None)
Env Vars#
Get Env Var#
Category: Env Vars
Description: Gets an environment variable value.
- Settings:
Variable (text): Name of the environment variable
- Outputs:
Result (text): The environment variable value
Set Env Var#
Category: Env Vars
Description: Sets an environment variable value.
- Settings:
Variable (text): Name of the environment variable
Value (text): Value to set
- Outputs:
(None)
Files#
Append File#
Category: Files
Description: Appends content to a file.
- Settings:
Path (text): File path
Text (text): Text to append
- Outputs:
Result: The result of the operation
Copy File#
Category: Files
Description: Copies a file from source to target location.
- Settings:
Source (text): Source file path
Target (text): Target file path
Overwrite (bool): Whether to overwrite if target exists (default: false)
- Outputs:
Result: The path to the copied file
Copy Folder#
Category: Files
Description: Copies a folder from source to target location.
- Settings:
Source (text): Source folder path
Target (text): Target folder path
Overwrite (bool): Whether to overwrite if target exists (default: false)
- Outputs:
Result: The path to the copied folder
Create Folder#
Category: Files
Description: Creates a new folder.
- Settings:
Path (text): Path where to create the folder
- Outputs:
Result: The result of the operation
Create Zip#
Category: Files
Description: Creates a ZIP archive from files.
- Settings:
Files (text): List of files to include
Zippath (text): Path for the ZIP file
- Outputs:
Zippath: The path to the created ZIP file
Delete File#
Category: Files
Description: Deletes a file.
- Settings:
File (text): File path to delete
- Outputs:
Result: The result of the operation
Delete Folder#
Category: Files
Description: Deletes a folder.
- Settings:
Source (text): Folder path to delete
Target (text): (Legacy parameter)
- Outputs:
Result: The result of the operation
Exists on Disk#
Category: Files
Description: Checks if a file or folder exists on disk.
- Settings:
Path (text): Path to check
- Outputs:
Result: True if the path exists, False otherwise
Extract Zip#
Category: Files
Description: Extracts files from a ZIP archive.
- Settings:
Zippath (text): Path to the ZIP file
Targetpath (text): Path where to extract files
- Outputs:
Files: List of extracted file paths
Get Files From Pattern#
Category: Files
Description: Gets a list of files matching a pattern (e.g., image sequences).
- Settings:
Pattern (text): File pattern to match
- Outputs:
Result (list): List of matching file paths
Get Folder Content#
Category: Files
Description: Gets the contents of a folder.
- Settings:
Path (text): Folder path
- Outputs:
Result: Dictionary with "folders" and "files" keys
Get Parent Folder#
Category: Files
Description: Gets the parent folder of a path.
- Settings:
Path (text): File or folder path
- Outputs:
Parentpath: The parent folder path
Get Temp Filepath#
Category: Files
Description: Generates a temporary file path.
- Settings:
Filename (text): Filename
Extension (text): File extension
- Outputs:
Filepath: The temporary file path
Move File#
Category: Files
Description: Moves a file from source to target location.
- Settings:
Source (text): Source file path
Target (text): Target file path
- Outputs:
Result: The path to the moved file
Move Folder#
Category: Files
Description: Moves a folder from source to target location.
- Settings:
Source (text): Source folder path
Target (text): Target folder path
- Outputs:
Result: The path to the moved folder
Open in Explorer#
Category: Files
Description: Opens a file or folder in the system file explorer.
- Settings:
File (text): Path to open
- Outputs:
File: The opened file path
Read from File#
Category: Files
Description: Reads text content from a file.
- Settings:
Path (text): File path to read
- Outputs:
Result: The file content as text
Write to File#
Category: Files
Description: Writes text content to a file.
- Settings:
Path (text): File path to write
Text (text): Text content to write
- Outputs:
Result: The result of the operation
Logical#
All#
Category: Logical
Description: Returns True if all values in a list are True.
- Settings:
Value (text): List of boolean values (default: "[True, True]")
- Outputs:
Result (bool): True if all values are True
And#
Category: Logical
Description: Performs a logical AND operation on multiple boolean values.
- Settings:
Value 1 (bool): First boolean value (default: true)
Value 2 (bool): Second boolean value (default: true)
Create Input: Button to add more inputs
- Outputs:
Result: True if all inputs are True
Any#
Category: Logical
Description: Returns True if any value in a list is True.
- Settings:
Value (text): List of boolean values (default: "[True, False]")
- Outputs:
Result (bool): True if any value is True
Bigger#
Category: Logical
Description: Compares if the first value is bigger than the second value.
- Settings:
Value 1 (float): First value (default: 0.0)
Value 2 (float): Second value (default: 0.0)
- Outputs:
Result: True if Value 1 > Value 2
Equal#
Category: Logical
Description: Checks if multiple values are equal.
- Settings:
Value 1 (text): First value
Value 2 (text): Second value
Create Input: Button to add more inputs
- Outputs:
Result: True if all values are equal
In#
Category: Logical
Description: Checks if a keyword is contained in a value.
- Settings:
Value (text): The value to search in
Keyword (text): The keyword to search for
- Outputs:
Result (bool): True if keyword is in value
Lower#
Category: Logical
Description: Compares if the first value is lower than the second value.
- Settings:
Value 1 (float): First value (default: 0.0)
Value 2 (float): Second value (default: 0.0)
- Outputs:
Result: True if Value 1 < Value 2
Not#
Category: Logical
Description: Performs a logical NOT operation on a boolean value.
- Settings:
Value (bool): Boolean value (default: true)
- Outputs:
Result: The inverted boolean value
Or#
Category: Logical
Description: Performs a logical OR operation on multiple boolean values.
- Settings:
Value 1 (bool): First boolean value (default: true)
Value 2 (bool): Second boolean value (default: true)
Create Input: Button to add more inputs
- Outputs:
Result: True if any input is True
MaterialX#
Create MaterialX Document#
Category: MaterialX
Description: Creates a new MaterialX document.
- Settings:
(None)
- Outputs:
MtlxDoc: The MaterialX document object
MaterialX Image#
Category: MaterialX
Description: Creates a MaterialX image node.
- Settings:
MtlxDoc: The MaterialX document
NodeName (text): Name for the image node
Shader (text): Shader to connect to
Imagepath (text): Path to the image file
- Outputs:
MtlxDoc: The MaterialX document object
Image: The created image node
MaterialX Standard Surface#
Category: MaterialX
Description: Creates a MaterialX standard surface shader.
- Settings:
MtlxDoc: The MaterialX document
NodeName (text): Name for the shader node
- Outputs:
MtlxDoc: The MaterialX document object
Shader: The created shader node
Save MaterialX#
Category: MaterialX
Description: Saves a MaterialX document to a file.
- Settings:
MtlxDoc: The MaterialX document
Filepath (text): Path where to save the document
- Outputs:
MtlxDoc: The MaterialX document object
Math#
Add#
Category: Math
Description: Adds multiple values together.
- Settings:
Value 1 (float): First value (default: 1.0)
Value 2 (float): Second value (default: 1.0)
Create Input: Button to add more inputs
- Outputs:
Result: The sum of all input values
Divide#
Category: Math
Description: Divides the first value by the second value.
- Settings:
Value 1 (float): First value (default: 1.0)
Value 2 (float): Second value (default: 1.0)
- Outputs:
Result: Value 1 divided by Value 2
Multiply#
Category: Math
Description: Multiplies multiple values together.
- Settings:
Value 1 (float): First value (default: 1.0)
Value 2 (float): Second value (default: 1.0)
Create Input: Button to add more inputs
- Outputs:
Result: The product of all input values
Substract#
Category: Math
Description: Subtracts values from the first value.
- Settings:
Value 1 (float): First value (default: 1.0)
Value 2 (float): Second value (default: 1.0)
Create Input: Button to add more inputs
- Outputs:
Result: Value 1 minus all other values
Nodegraph#
Backdrop#
Category: Nodegraph
Description: A backdrop node for organizing and annotating the node graph.
- Settings:
Color (text): Background color (default: "[100, 200, 100, 50]")
Size (text): Size of the backdrop (default: "[200, 100]")
Text (multilinetext): Text to display
Text Size (int): Font size (default: 20)
Text Color (text): Text color (default: "[255, 255, 255, 255]")
Text Alignment (combobox): Text alignment position
Locked (bool): Whether the backdrop is locked (default: false)
- Outputs:
(None)
Dot#
Category: Nodegraph
Description: A reroute node to organize connections in the node graph.
- Settings:
Input: The input value to pass through
- Outputs:
Output: The same value as the input
Portal#
Category: Nodegraph
Description: References outputs from another node in the graph.
- Settings:
Node (text): Name of the node to reference
Refresh: Button to refresh the portal
- Outputs:
(Dynamically created based on referenced node)
Text#
Category: Nodegraph
Description: A text annotation node for the node graph.
- Settings:
Text (multilinetext): The text to display (default: "Text")
Color (text): Text color (default: "[200, 200, 200, 255]")
Background Color (text): Background color (default: "[100, 100, 100, 100]")
Size (int): Font size (default: 20)
- Outputs:
(None)
Other#
Continue Execution#
Category: Other
Description: Continues execution in a loop, skipping remaining nodes.
- Settings:
(None)
- Outputs:
Result: None
__continue__ (hidden): Internal flag
Example#
Category: Other
Description: An example node demonstrating all available setting types.
- Settings:
Int (int): Integer value (default: 1)
Float (float): Float value (default: 1.0)
Bool (bool): Boolean value (default: true)
Text (text): Text value (default: "lorem ipsum")
Multilinetext (multilinetext): Multiline text
Button: Example button
- Outputs:
Result: Always returns True
For Each#
Category: Other
Description: Iterates over items and executes a subgraph for each item.
- Settings:
Items: List of items to iterate over (default: [])
Create Input: Button to add additional inputs
Create Output: Button to add additional outputs
- Outputs:
Result (list): List of results from each iteration
Get Node Data#
Category: Other
Description: Gets data from the subgraph of a node.
- Settings:
Create Input: Button to add inputs
Create Output: Button to add outputs
- Outputs:
JsonData: JSON representation of the subgraph
PythonCommand: Python command to execute the subgraph
Group#
Category: Other
Description: A container node that executes a subgraph.
- Settings:
Create Input: Button to add inputs
Create Output: Button to add outputs
- Outputs:
Result: Dictionary of outputs from the subgraph
HTTP Request#
Category: Other
Description: Performs an HTTP request.
- Settings:
URL (text): The URL to request
Method (combobox): HTTP method (GET, POST, PUT, DELETE, etc.)
Headers (multilinetext): Request headers as JSON
Body (multilinetext): Request body
Timeout (int): Request timeout in seconds (default: 30)
Query Parameters (multilinetext): URL query parameters
Authentication (multilinetext): Authentication string
Verify SSL (bool): Whether to verify SSL certificates (default: true)
- Outputs:
Response: The response body
StatusCode: HTTP status code
ResponseHeaders: Response headers
Success: True if status code < 400
If#
Category: Other
Description: Conditional execution node that routes execution based on a condition.
- Settings:
Condition (bool): The condition to evaluate (default: true)
- Outputs:
execution (Then): Executed if condition is True
execution2 (Else): Executed if condition is False
Result: The boolean result of the condition
ExecutionPort (hidden): Internal routing
Inputs#
Category: Other
Description: Acts as the starting point of (sub-)graphs. Created automatically and cannot be created manually.
- Settings:
Create Input: Adds a new input to this node
- Outputs:
(Dynamically created based on graph inputs)
Loop#
Category: Other
Description: Executes a subgraph multiple times.
- Settings:
Count (int): Number of iterations (default: 0)
Create Input: Button to add additional inputs
Create Output: Button to add additional outputs
- Outputs:
Result (list): List of results from each iteration
Merge#
Category: Other
Description: Merges multiple inputs into a single list.
- Settings:
Inputs: Multiple input connections
- Outputs:
Result (list): List of all input values
Outputs#
Category: Other
Description: Defines the outputs of a (sub-)graph. Created automatically and cannot be created manually.
- Settings:
Result: The result values
Create Output: Adds a new output to this node
- Outputs:
(None - outputs are defined by the node settings)
Popup#
Category: Other
Description: Shows a popup message dialog.
- Settings:
Message (multilinetext): The message to display (default: "hello world")
Type (combobox): Type of popup (Info, Warning, Error)
- Outputs:
Result: The result of showing the popup
Popup Question#
Category: Other
Description: Shows a popup dialog with question buttons.
- Settings:
Message (multilinetext): The message to display (default: "hello world")
Type (combobox): Icon type (Question, Info, Warning, Error)
Buttons (text): Button labels separated by comma (default: "Yes, No")
- Outputs:
Result: The selected button text
Read CSV#
Category: Other
Description: Reads data from a CSV file.
- Settings:
Filepath (text): Path to the CSV file
- Outputs:
Result: List of rows from the CSV file
Run Executable#
Category: Other
Description: Runs an executable with arguments.
- Settings:
Executable (text): Path to the executable (default: "python")
Arguments (text): Command line arguments
Environment (dict): Environment variables (default: "startenv")
Wait (bool): Whether to wait for completion (default: true)
- Outputs:
Result: The result of the execution
Run Shell Command#
Category: Other
Description: Runs a shell command.
- Settings:
Command (text): The shell command to run
Environment: Environment variables
Wait (bool): Whether to wait for completion (default: true)
- Outputs:
(None)
Stop Execution#
Category: Other
Description: Stops execution in a loop or graph.
- Settings:
(None)
- Outputs:
Result: None
__stop__ (hidden): Internal flag
Switch#
Category: Other
Description: Returns one of two values based on a condition.
- Settings:
Condition (bool): The condition to evaluate (default: true)
Value 1 (int): Value to return if condition is True (default: 0)
Value 2 (int): Value to return if condition is False (default: 1)
- Outputs:
Result: Value 1 if condition is True, otherwise Value 2
User Input#
Category: Other
Description: Shows a dialog to get user input.
- Settings:
Label (text): Input label (default: "Value:")
Type (combobox): Input type (String, Int, Float, Bool, File Path, etc.)
Default (text): Default value
Show (bool): Whether to show the dialog immediately (default: true)
Window: Window object for multiple inputs
- Outputs:
execution (Accepted): Executed if user accepts
execution2 (Canceled): Executed if user cancels
Result: The input value
ExecutionPort (hidden): Internal routing
Wait#
Category: Other
Description: Pauses execution for a specified time.
- Settings:
Seconds (int): Number of seconds to wait (default: 1)
- Outputs:
(None)
Write to Log#
Category: Other
Description: Writes a message to the execution log.
- Settings:
Message (text): The message to write
Severity (text): Message severity (default: "info")
Prefix (text): Message prefix
- Outputs:
(None)
Polyhaven#
Download Polyhaven Asset#
Category: Polyhaven
Description: Downloads an asset from Polyhaven.
- Settings:
Type (text): Asset type
Category (text): Asset category
Asset (text): Asset name
- Outputs:
Outputpaths: Path to the downloaded asset
Get Polyhaven Asset Paths#
Category: Polyhaven
Description: Gets file paths for a Polyhaven asset.
- Settings:
Type (text): Asset type
Category (text): Asset category
Asset (text): Asset name
- Outputs:
Paths: List of asset file paths
Get Polyhaven Assets#
Category: Polyhaven
Description: Gets a list of assets from Polyhaven.
- Settings:
Type (text): Asset type
Category (text): Asset category
- Outputs:
Type: The asset type
Category: The category
Assets: List of asset names
Get Polyhaven Categories#
Category: Polyhaven
Description: Gets available categories from Polyhaven.
- Settings:
Type (text): Asset type
- Outputs:
Type: The asset type
Categories: List of category names
Prism#
Add Media Version to Playlist#
Category: Prism
Description: Adds media versions to a playlist in the project management system.
- Settings:
Playlist (text): Name of the playlist
Media Version (dict): Media version data (default: {})
- Outputs:
Result: The result of the operation
Convert Media#
Category: Prism
Description: Converts media files to a different format.
- Settings:
Filepath (text): Path to the media file
Format (text): Target format
Preset (text): Conversion preset name
- Outputs:
Outputpath: Path to the converted file
Create Asset#
Category: Prism
Description: Creates a new asset in the Prism project.
- Settings:
Name (text): Asset name (default: "asset")
Description (text): Asset description
- Outputs:
Asset (dict): The created asset data
Create Department#
Category: Prism
Description: Creates a new department for an entity.
- Settings:
Entity: The entity to create the department for (default: {})
Name (text): Department name (default: "mod")
- Outputs:
Entity (dict): The entity data
Department (text): The department name
Create Project#
Category: Prism
Description: Creates a new Prism project.
- Settings:
Name (text): Project name (default: "New Project")
Path (text): Project path
Preset (text): Project preset (default: "Default")
Settings: Additional project settings (default: {})
- Outputs:
Project (text): The created project path
Create Scenefile from Preset#
Category: Prism
Description: Creates a new scenefile from a preset template.
- Settings:
Entity: The entity for the scenefile (default: {})
Department (text): Department name (default: "mod")
Task (text): Task name (default: "Modeling")
Preset (text): Preset name
Comment (text): Version comment
- Outputs:
Filepath (text): Path to the created scenefile
Create Shot#
Category: Prism
Description: Creates a new shot in the Prism project.
- Settings:
Sequence (text): Sequence name (default: "sq010")
Name (text): Shot name (default: "sh010")
Framerange (text): Frame range (default: "1001-1100")
LinkedAssets (text): Linked asset paths (default: "[]")
- Outputs:
Shot (dict): The created shot data
Create State#
Category: Prism
Description: Creates a new state in the State Manager.
- Settings:
Settings (multilinetext): State settings as JSON
execution
- Outputs:
Result: The created state object
Create Task#
Category: Prism
Description: Creates a new task for an entity.
- Settings:
Entity: The entity (default: {})
Department (text): Department name (default: "mod")
Name (text): Task name (default: "Modeling")
- Outputs:
Entity (dict): The entity data
Department (text): The department name
Task (text): The task name
Get Asset#
Category: Prism
Description: Gets an asset by its path.
- Settings:
Assetpath (text): Asset path
- Outputs:
Asset: The asset data
Get Assets#
Category: Prism
Description: Gets all assets in the project.
- Settings:
(None)
- Outputs:
Assets (list): List of all assets
Get Config#
Category: Prism
Description: Gets a configuration value from a Prism config file.
- Settings:
Config (text): Config name (default: "project")
Category (text): Config category (default: "globals")
Key (text): Config key (default: "project_name")
- Outputs:
Result: The configuration value
Get Current Project#
Category: Prism
Description: Gets information about the current Prism project.
- Settings:
(None)
- Outputs:
Name (text): Project name
Path (text): Project path
Settings (dict): Project settings
Get Current Scenefile Data#
Category: Prism
Description: Gets data about the currently open scenefile.
- Settings:
(None)
- Outputs:
Result: Scenefile data dictionary
Get Departments#
Category: Prism
Description: Gets all departments for an entity.
- Settings:
Entity: The entity (default: {})
- Outputs:
Departments (list): List of department names
Get File from Media Version#
Category: Prism
Description: Gets a file from a media version.
- Settings:
Version: Media version data (default: {})
AOV (text): AOV name (default: "beauty")
- Outputs:
File: Path to the media file
Get Media Identifiers#
Category: Prism
Description: Gets all media identifiers for an entity.
- Settings:
Entity: The entity (default: {})
Media Type (combobox): Type of media (3d, 2d, playplast, external)
- Outputs:
Names (list): List of identifier names
Identifiers (list): List of identifier data
Get Media Version#
Category: Prism
Description: Gets a specific media version.
- Settings:
Entity: The entity (default: {})
Identifier (text): Media identifier
Media Type (combobox): Type of media (default: "3drenders")
Version (text): Version name (default: "latest")
- Outputs:
Version: Media version data
Get Media Versions#
Category: Prism
Description: Gets all versions of a media identifier.
- Settings:
Entity: The entity (default: {})
Identifier (text): Media identifier
Media Type (combobox): Type of media (default: "3drenders")
Limit (text): Limit range (e.g., "2:4")
Include Master (bool): Whether to include master version (default: true)
- Outputs:
Versions (list): List of media versions
Get Plugin#
Category: Prism
Description: Gets a Prism plugin by name.
- Settings:
Name (text): Plugin name
- Outputs:
Plugin: The plugin object
Name: Plugin name
Path: Plugin directory path
Get Preferred File from Product Version#
Category: Prism
Description: Gets the preferred file from a product version.
- Settings:
ProductVersion: Product version data (default: {})
- Outputs:
Filepath: Path to the preferred file
Get Prism Instance#
Category: Prism
Description: Gets the Prism core instance.
- Settings:
(None)
- Outputs:
Prism: The Prism core object
Get Product Version#
Category: Prism
Description: Gets a specific product version.
- Settings:
Entity: The entity (default: {})
Product (text): Product name (default: "USD")
Version (text): Version name (default: "latest")
Include Master (bool): Whether to include master version (default: true)
- Outputs:
ProductVersion (dict): Product version data
Get Product Versions#
Category: Prism
Description: Gets all versions of a product.
- Settings:
Entity: The entity (default: {})
Product (text): Product name
Limit (text): Limit range (e.g., "2:4")
Include Master (bool): Whether to include master version (default: true)
- Outputs:
Versions (list): List of product versions
Get Products#
Category: Prism
Description: Gets all products for an entity.
- Settings:
Entity: The entity (default: {})
- Outputs:
Products (list): List of product names
Get Scenefile#
Category: Prism
Description: Gets a specific scenefile.
- Settings:
Entity: The entity (default: {})
Department (text): Department name (default: "mod")
Task (text): Task name (default: "Modeling")
Version (text): Version (default: "latest")
- Outputs:
Filepath (text): Path to the scenefile
MetaData (dict): Scenefile metadata
Get Scenefiles#
Category: Prism
Description: Gets all scenefiles for a task.
- Settings:
Entity: The entity (default: {})
Department (text): Department name (default: "mod")
Task (text): Task name (default: "Modeling")
Limit (text): Limit range (e.g., "2:4")
- Outputs:
Scenefiles (list): List of scenefile paths
Get Sequences#
Category: Prism
Description: Gets all sequences in the project.
- Settings:
Episode (text): Episode name (optional)
- Outputs:
Sequences (list): List of sequence names
Get Shot#
Category: Prism
Description: Gets a specific shot.
- Settings:
Sequence (text): Sequence name
Shot (text): Shot name
- Outputs:
Shot: Shot data
Get Shots#
Category: Prism
Description: Gets shots from sequences.
- Settings:
Sequence (text): Sequence name (comma-separated for multiple)
Filter (text): Search filter
- Outputs:
Shots (list): List of shot data
Get Task#
Category: Prism
Description: Gets task metadata.
- Settings:
Entity: The entity (default: {})
Department (text): Department name (default: "mod")
Task (text): Task name (default: "Modeling")
- Outputs:
MetaData (dict): Task metadata
Get Tasks#
Category: Prism
Description: Gets all tasks for a department.
- Settings:
Entity: The entity (default: {})
Department (text): Department name (default: "mod")
- Outputs:
Tasks (list): List of task names
Import Product#
Category: Prism
Description: Imports a product file into the current scene.
- Settings:
Filepath (text): Path to the product file
- Outputs:
Result: Import result
Ingest Media Version#
Category: Prism
Description: Ingests media files as a new media version.
- Settings:
Files (text): File paths to ingest
Entity: The entity (default: {})
Identifier (text): Media identifier
- Outputs:
CreatedFiles: List of created file paths
VersionPath: Path to the version folder
Ingest Product Version#
Category: Prism
Description: Ingests files as a new product version.
- Settings:
Files (text): File paths to ingest
Entity: The entity (default: {})
Product (text): Product name
Comment (text): Version comment
- Outputs:
CreatedFiles: List of created file paths
VersionPath: Path to the version folder
Open in Media Player#
Category: Prism
Description: Opens a media file in an external media player.
- Settings:
File (text): File path
Player Name (text): Name of the media player
- Outputs:
File: The file path
Open Project Browser#
Category: Prism
Description: Opens the Prism Project Browser.
- Settings:
(None)
- Outputs:
Result: The Project Browser widget
Open Scenefile#
Category: Prism
Description: Opens a scenefile in the DCC application.
- Settings:
Filepath (text): Path to the scenefile
- Outputs:
Result: Result of opening the file
Open USD Quickview#
Category: Prism
Description: Opens a USD file in the USD Quickview.
- Settings:
USDFile (text): Path to the USD file
- Outputs:
Quickview: The Quickview widget
Publish#
Category: Prism
Description: Publishes states from the State Manager.
- Settings:
States (list): List of states to publish (default: [])
- Outputs:
Result: Publish result
Refresh Project Browser#
Category: Prism
Description: Refreshes the Project Browser UI.
- Settings:
(None)
- Outputs:
(None)
Save Scenefile#
Category: Prism
Description: Saves the current scene as a Prism version.
- Settings:
Entity: The entity (default: {})
Department (text): Department name
Task (text): Task name
Version (text): Version (default: "next")
Comment (text): Version comment
Filepath (text): Custom filepath (optional)
- Outputs:
Result: Save result
Select in Project Browser#
Category: Prism
Description: Selects an entity in the Project Browser.
- Settings:
Entity (text): Entity to select
- Outputs:
Result: Whether the selection was successful
Send Command to DCC#
Category: Prism
Description: Sends a command to a DCC application via inter-process communication.
- Settings:
DCC (text): DCC name (default: "Houdini")
Command (multilinetext): Command to execute
Retry on Error (bool): Whether to retry on error (default: true)
Timeout (int): Timeout in seconds (default: 10)
- Outputs:
(None)
Set Active Project#
Category: Prism
Description: Sets the active Prism project.
- Settings:
Path (text): Project path
- Outputs:
Result: Whether the project was set successfully
Set Config#
Category: Prism
Description: Sets a configuration value in a Prism config file.
- Settings:
Config (text): Config name (default: "project")
Category (text): Config category (default: "globals")
Key (text): Config key (default: "fps")
Value (text): Value to set (default: "30")
- Outputs:
Result: The result of the operation
Set Entity Preview#
Category: Prism
Description: Sets a preview image for an entity.
- Settings:
Entity (dict): The entity (default: {})
Filepath (text): Path to the preview image
- Outputs:
Result: The result of the operation
Project Management#
FTrack Media Publish#
Category: Project Management
Description: Publishes media to FTrack.
- Settings:
Mediapaths (list): List of media file paths (default: "[]")
Entity (dict): The entity (default: {})
Task (text): Task name
Version (text): Version name (default: "v0001")
Description (text): Version description
- Outputs:
Result: Publish result
Kitsu Media Publish#
Category: Project Management
Description: Publishes media to Kitsu.
- Settings:
Mediapaths (list): List of media file paths (default: "[]")
Entity (dict): The entity (default: {})
Task (text): Task name
Version (text): Version name (default: "v0001")
Description (text): Version description
- Outputs:
Result: Publish result
Shotgrid Media Publish#
Category: Project Management
Description: Publishes media to Shotgrid.
- Settings:
Mediapaths (list): List of media file paths (default: "[]")
Entity (dict): The entity (default: {})
Task (text): Task name
Version (text): Version name (default: "v0001")
Description (text): Version description
- Outputs:
Result: Publish result
Scripting#
Add to Dict#
Category: Scripting
Description: Adds a key-value pair to a dictionary.
- Settings:
Dict (text): Dictionary (default: "{}")
Key (text): Key to add
Value (text): Value to set
- Outputs:
Result: The updated dictionary
Add to List#
Category: Scripting
Description: Adds values to a list.
- Settings:
List (text): List (default: "[]")
Value (text): Value to add
Create Input: Button to add more inputs
- Outputs:
Result: The updated list
Append String#
Category: Scripting
Description: Appends one string to another.
- Settings:
Base String (multilinetext): Base string
Append String (multilinetext): String to append
- Outputs:
String (text): The concatenated string
Combine Lists#
Category: Scripting
Description: Combines two lists into one.
- Settings:
List1 (text): First list (default: "[]")
List2 (text): Second list
- Outputs:
Result (list): The combined list
Extract Dict#
Category: Scripting
Description: Extracts a value from a dictionary by key.
- Settings:
Dict (text): Dictionary (default: "{}")
Key (text): Key to extract
execution
- Outputs:
Result: The extracted value
Extract List#
Category: Scripting
Description: Extracts an item from a list by index.
- Settings:
List (list): List (default: "[]")
Index (int): Index (default: 0)
- Outputs:
Result: The extracted item
Format String#
Category: Scripting
Description: Formats a string template with values from a dictionary.
- Settings:
Template (multilinetext): String template
Dict (text): Dictionary with values (default: "{}")
- Outputs:
Result (text): The formatted string
Join List to String#
Category: Scripting
Description: Joins list items into a string.
- Settings:
List (text): List to join (default: "[]")
Join String (multilinetext): String to join with (default: "\n")
- Outputs:
String (text): The joined string
List Comprehension#
Category: Scripting
Description: Performs a list comprehension operation.
- Settings:
List (text): Input list (default: "[]")
Collect Expression (text): Expression to collect (default: "item")
Condition (text): Filter condition (default: "True")
- Outputs:
Result (list): The filtered/transformed list
Monkeypatch#
Category: Scripting
Description: Monkey patches a function with custom code.
- Settings:
Function (text): Function name (default: "core.getFrameRange")
Code (multilinetext): Replacement code
- Outputs:
Result: The result of the operation
Python#
Category: Scripting
Description: Executes custom Python code.
- Settings:
Script (multilinetext): Python code to execute (default: "print(\"hello\")\nResult=True")
GUIThread (bool): Execute in GUI thread (default: false)
Create Input...: Button to add inputs
Create Output...: Button to add outputs
Load Example...: Button to load example scripts
- Outputs:
Result: The result from the script
Replace String#
Category: Scripting
Description: Replaces text in a string.
- Settings:
String (text): Input string
Search (text): Text to search for
Replace (text): Replacement text
- Outputs:
String (text): The string with replacements
Split List#
Category: Scripting
Description: Extracts a slice from a list.
- Settings:
List (text): Input list (default: "[]")
From (int): Start index (default: 0)
To (int): End index (default: 1)
- Outputs:
Result (list): The sliced list
Split String#
Category: Scripting
Description: Splits a string into a list.
- Settings:
String (text): String to split
Splitter (text): Delimiter to split on
- Outputs:
Result (list): List of string parts
Spreadsheets#
Read Google Sheet#
Category: Spreadsheets
Description: Reads data from a Google Sheet.
- Settings:
Credentials (text): Path to credentials file (default: "credentials.json")
Sheet Name (text): Name of the sheet (default: "My Sheet")
- Outputs:
Result (list): List of sheets with row data
Read ODS Spreadsheet#
Category: Spreadsheets
Description: Reads data from an ODS spreadsheet file.
- Settings:
Filepath (text): Path to the ODS file
- Outputs:
Result (list): List of sheets with row data
USD#
Assign USD Material#
Category: USD
Description: Assigns a material to a USD primitive.
- Settings:
Stage: USD stage
Path (text): Primitive path (default: "/prim")
Material (text): Material path
- Outputs:
Stage: The USD stage
Create USD Variant#
Category: USD
Description: Creates a variant on a USD primitive.
- Settings:
Stage: USD stage (default: null)
Primitive Path (text): Path to the primitive (default: "/prim")
Variant Set (text): Variant set name (default: "geo")
Variant Name (text): Variant name (default: "variant1")
Edit Variant (bool): Set as edit target (default: true)
- Outputs:
Stage: The USD stage
Define USD Prim#
Category: USD
Description: Defines a USD primitive with a specific type.
- Settings:
Stage: USD stage (default: null)
Path (text): Primitive path (default: "/prim")
Type (text): Primitive type (default: "Xform")
- Outputs:
Stage: The USD stage
Delete USD Attribute#
Category: USD
Description: Deletes an attribute from a USD primitive.
- Settings:
Stage: USD stage (default: null)
Path (text): Primitive path (default: "/prim")
Attribute (text): Attribute name
- Outputs:
Stage: The USD stage
Delete USD Prim#
Category: USD
Description: Deletes a USD primitive.
- Settings:
Stage: USD stage (default: null)
Path (text): Primitive path (default: "/prim")
- Outputs:
Stage: The USD stage
Get USD Prim#
Category: USD
Description: Gets a USD primitive by path.
- Settings:
Stage: USD stage (default: null)
Path (text): Primitive path (default: "/prim")
- Outputs:
Prim: The USD primitive
Path: The primitive path
Open USD Stage#
Category: USD
Description: Opens or creates a USD stage.
- Settings:
Filepath (text): Path to USD file
Open as Anonymous Stage (bool): Open as anonymous (default: false)
- Outputs:
Stage: The USD stage object
Parent USD Prim#
Category: USD
Description: Parents a USD primitive under another primitive.
- Settings:
Stage: USD stage (default: null)
Source Path (text): Primitive to parent (default: "/prim")
Parent Path (text): New parent path (default: "/parent")
- Outputs:
Stage: The USD stage
Rename USD Prim#
Category: USD
Description: Renames a USD primitive.
- Settings:
Stage: USD stage (default: null)
Path (text): Primitive path (default: "/prim")
Name (text): New name (default: "name")
- Outputs:
Stage: The USD stage
Render Turntable#
Category: USD
Description: Renders a turntable animation of a USD asset.
- Settings:
Filepath (text): Path to USD file
Entity: The entity (default: {})
Duration (int): Number of frames (default: 24)
Identifier (text): Media identifier (default: "turntable")
Renderer (text): Renderer to use (default: "Storm")
Frame Duration (int): Frames per step (default: 1)
- Outputs:
Outputpath: Path to rendered media
Save USD Department Layer#
Category: USD
Description: Saves a USD department layer for an entity.
- Settings:
Stage: USD stage (default: null)
Entity: The entity (default: null)
Department (text): Department name
- Outputs:
Filepath: Path to the saved layer
Save USD Stage#
Category: USD
Description: Saves a USD stage to a file.
- Settings:
Stage: USD stage (default: null)
Filepath (text): Path where to save
- Outputs:
Filepath: Path to the saved file
USD Add Layer#
Category: USD
Description: Adds a layer to a USD stage.
- Settings:
Stage: USD stage (default: null)
Layer Path (text): Path to the layer file
Position (int): Insert position (default: -1)
- Outputs:
Stage: The USD stage
USD Add Reference#
Category: USD
Description: Adds a reference or payload to a USD stage.
- Settings:
Stage: USD stage (default: null)
Reference Path (text): Path to reference file
Payload (bool): Add as payload (default: true)
Source Prim (text): Source primitive path (default: "/prim")
Target Prim (text): Target primitive path (default: "/prim")
- Outputs:
Stage: The USD stage
USD Set Edit Target#
Category: USD
Description: Sets the edit target for a USD stage.
- Settings:
Stage: USD stage (default: null)
Layer (text): Layer identifier (default: "root")
Primitive Path (text): Primitive path (default: "/prim")
Variant Set (text): Variant set name (default: "geo")
Variant Name (text): Variant name (default: "variant1")
- Outputs:
Stage: The USD stage